IDBFunction method
Calling this method executes the specified action against the index.
The most common use of this method is to update the index.
Member of
Index
Type
Sub(Action)
Parameters
- Action: String - The action to perform on the index. The action syntax consists of command,
optionally followed by space-delimited parameters, e.g. "LIST ALPHA" will present the user
with the list of the documents in the index, sorted in alphabetic order.
The command can be one of the following:
- UPDATE - Updates the index to match changes in documents.
Parameters:
- PRESORT - Sort the entries into chronological order.
- PRESORT REVERSE - Sort the entries into reverse chronological order.
- PRESORT NAME - Sort the entries into alphabetical order based on file name.
- PRESORT PATH - Sort the entries into alphabetical order based on full path.
- CREATE - Initializes the index.
Parameters:
- REGARDLESS - If the index already exists, reinitialize it.
If the parameter is omitted, existing indexes will not be re-initialized.
- OPTIMIZE - Processes the index for optimal space utilization.
- REINDEX - Re-initializes the index and processes its documents.
Parameters:
- REGARDLESS - If the index already exists, reinitialize it.
If the parameter is omitted, existing indexes will not be re-initialized.
- PREVIEW - Scans documents for changes.
Parameters:
- DETAIL - Include full details. If omitted, only the summary will display.
- STATISTICS - Gathers and reports statistics for the index.
- FREQ - Lists word frequency for the index.
Parameters:
- base - The letters that the word must start with.
- count - The minimum frequency.
- TOP - Display only the 20 most populous words (which may be good candidates to be added to the ISYS.CWD file).
- TOP n - Display the n most populous words.
- LIST - Displays the documents, contained in the index.
Parameters:
- REVERSE - List documents in reverse chronological order. If no parameters are specified,
the default is to list the documents in chronological order.
- ALPHA - List documents in alphabetic sequence.
- other - If any other word is given as a parameter, it is interpreted as a filter.
The document name must contain this string to be included in the list.
- COMMON - Lists the common words in the index in alphabetical order.
- VERSION - Returns the complete Perceptive Search version number.
- USERS - Returns the number of active and licensed users.
- SUPPORT - Provides a number of index integrity checks.
Parameters:
- CHECK - Checks index integrity.
- CHECK LITE - Faster, less thorough integrity check.
- STATS - Displays index statistics.
- FORMATS - Lists selected formats.
- CATEGORIES - Lists generated categories.
- CATEGORIES COUNT - Lists categories with document tallies.
- KEYENTS - Lists the 20 main entities of each type.
- SHOWDELCACHE - Lists documents deferred for deletion.
- CHECKCFG - Verify whether ISYS.CFG settings have changed which would require a REINDEX, and, if so, indicate which setting.
- FINDDUPES - Lists duplicate documents (if detection enabled).
- DIFDIR - List all files under current directory not in the index.
- SCANTRACE ON - Trace details of document enumeration process to C:\ISYSLOG.TXT
- TIMING ON - Log timing details of key index update stages to the file "ISYSindexTimings.LOG" in the index directory.
- ADD - Adds document(s) to the index.
Parameters:
- folder(s) - This parameter can be a space-delimited list of folders names, enclosed in double quotes where necessary.
The specified folders must be among those that would normally be encompassed by the index update.
If this parameter is omitted, the entire name space of the index is enumerated and new documents added.
- RECATEGORIZE - Forces the document categories to be recalculated.
- REFRESHSECURITY - Forces security information to be updated.
- PROCESSCACHEDDELETES - Forces deferred deletions to be processed.
Example
For Each Index in App.Indexes
Index.IDBFunction "UPDATE"
Next
See Also
Macro Object Model
Index